Skip to main content

Markdown

Markdown is a text component that allows more formatting than Paragraph.

A general introduction of markdown style can be found here.

Examples​

There are two main ways to provide content for Markdown component.

File​

The following text generate the markdown example up to this line. 

# Markdown

Markdown is a text component that allows more formatting than Paragraph.

A general introduction of markdown style can be found [here](https://www.markdownguide.org/basic-syntax).

## Example
The following text generate the markdown example up to this line.

To use the Markdown component:

  • First drag the component to the canvas
  • Copy the above text and save it as 'markdown.md'
  • Select Data Type as File
  • Upload the markdown file under the component
  • Your markdown content is now visible

String​

This option should be used for dynamic contents generation, i.e. through the workflow steps or models. In this example we'll use ui store. Due to ui store expecting a regular string line breaks can't be used. Therefore we have to replace all line breaks with \n which is an explicit way to say we're expecting a new line.

Example data:

'# Markdown \n Markdown is a text component that allows more formatting than Paragraph.'

To use the markdown component:

  • Go to Data section in ui-builder and choose ui only. Note: you can use any other linkable store option
  • Create new key, let's call it markdown-content
  • Copy the example data above and paste it into the markdown-content (please note the quote at the beginning and end of the text is important here)
  • Save the store key
  • In component select Data Type as String
  • Now in MD Content click the chain icon to link the property
  • Select Ui only and pick markdown-content, hit save
  • Your markdown content is now visible